home *** CD-ROM | disk | FTP | other *** search
/ Magnum One / Magnum One (Mid-American Digital) (Disc Manufacturing).iso / d21 / qwhite10.arc / QWHITE.TEC < prev    next >
Text File  |  1990-08-16  |  17KB  |  343 lines
  1. ID:QW Quarterdeck White Papers
  2. Quarterdeck Technical Note
  3. by Daniel Travison
  4.  
  5.    Welcome aboard the Quarterdeck White Papers!  The White Papers
  6.    originated as separate documents prepared by our Technical Support
  7.    Staff.  Each one explores a single topic of importance to users of
  8.    Quarterdeck products. They were originally written as independent items
  9.    in response to inquires by our users. Previous versions have been
  10.    distributed by mail and FAX as one avenue of supporting our customers.
  11.    Over a period of time these Papers tend to change; there are additions
  12.    and deletions all the time as products evolve.  Rather than distribute a
  13.    paper version, we hope you will enjoy our diskette version which
  14.    respects the environment.
  15.  
  16.    The Quarterdeck White Papers program (QWHITE.COM) is a DESQview-specific
  17.    program for viewing these technical notes within DESQview.   QWHITE.COM
  18.    is NOT designed to replace your favorite file viewing utilities.  It is
  19.    written specifically to provide quick access to Quarterdeck's technical
  20.    notes, or your own, using an interface similar to DESQview's Open Window
  21.    menu.
  22.  
  23. Using DESQview's Add A Program:
  24.  
  25.    > Place all of the technical notes and QWHITE programs in the same
  26.      subdirectory.  This is normally done by the install program.
  27.  
  28.    > Select Open Window from the DESQview menu
  29.  
  30.    > Select Add A Program from the Open Window Menu.
  31.  
  32.    > Select 'Other (Add Program Not in List)' by pressing the O key or by
  33.      clicking on the selection with the mouse.
  34.  
  35.    > Type the drive and subdirectory where QWHITE.COM is located in the
  36.      path field.  For Example: If you have installed the Quarterdeck White
  37.      Papers to the subdirectory QWHITE on the C drive type in the following
  38.      and press the enter key:
  39.  
  40.            C:\QWHITE
  41.  
  42.    > An entry 'Quarterdeck White' will be displayed, move the cursor to
  43.      this entry, press the space bar, then press enter.  The Quarterdeck
  44.      White Papers is configured to use QW as the keys to use on the open
  45.      window menu. If QW is already in use, you will be prompted to provide
  46.      a different two-key combination.
  47.  
  48. Change A Program:
  49.  
  50.    Conventional Memory: 95k
  51.    System Memory:       15k
  52.  
  53.    QWHITE.COM requires 95k to run.  If you have expanded memory available,
  54.    QWHITE.COM will automatically load the technical note into expanded
  55.    memory, reducing its conventional memory overhead to 31k. This allows you
  56.    to set the Memory Size field in Change A Program to 31.  QWHITE.COM will
  57.    automatically notify you if it can not allocate enough memory to run
  58.    correctly.
  59.  
  60.    QWHITE.COM also requires about 15k of System Memory to function
  61.    correctly.  System memory is a block of memory DESQview allocates on
  62.    behalf of a program that uses DESQview's Applications Programming
  63.    Interface (API).  This memory is used to store some of the program's
  64.    DESQview specific data.  For example, when you select HELP for the
  65.    program, the help screen is stored in system memory.
  66.  
  67.    The System Memory field is found on the Advanced Options screen of
  68.    Change A Program.  DESQview will notify you if it runs out of system
  69.    memory for the program at any point.  If you receive an error message
  70.    from DESQview indicating there is insufficient system memory for the
  71.    program, increase the System Memory field by 1 and run the program
  72.    again.
  73.  
  74. The Main menu:
  75.  
  76.    The main menu contains 5 selections:
  77.  
  78.    Open Technote: Displays a menu of technical notes in a format similar to
  79.       DESQview's Open window menu. This menu can contain up to 256 entries.
  80.  
  81.    Search Technote: Allows searching all technotes for a character string.
  82.  
  83.    Create New Open Menu: Tells QWHITE.COM to scan all files in the current
  84.       directory for files that contain a specific header record.
  85.  
  86.    Help: Displays a help screen describing each menu option.
  87.  
  88.    Quit: Allows quiting the Quarterdeck White Papers.
  89.  
  90. Getting Help:
  91.  
  92.    QWHITE.COM has two methods for obtaining help.  The first uses
  93.    DESQview's help system.  Normally, when you bring up the DESQview menu
  94.    you see an option called 'Help for DESQview'.  When you bring up the
  95.    DESQview menu while QWHITE.COM is the foreground program, you will see
  96.    an entry 'Help For Program'.  You may press the ? key at this point to
  97.    activate QWHITE.COM's help.  Additionally, you can press the ? key from
  98.    most screens to display help specific to the screen.
  99.  
  100. Open Technote:
  101.  
  102.    The Open Technote menu option provides a menu of technical notes in a
  103.    manner similar to DESQview's Open Window menu.  However, instead of
  104.    opening a window to run a program, this option allows you to open
  105.    a window to read a technote.
  106.  
  107.    To read a technote, highlight the entry with the mouse and click either
  108.    mouse button, -or- highlight the entry with the Up and Down cursor keys
  109.    and press the spacebar, -or- type the two letters to the right of the
  110.    entry. If two or more entries displayed have the same two-letter
  111.    combination, you will need to select the second, third, etc. entry with
  112.    the mouse or cursor keys.   The PgDn and PgUp keys are used to display
  113.    the the entries on other screens.
  114.  
  115. Two-key limitations:
  116.  
  117.    QWHITE.COM will only accept files that use the letters A through Z and
  118.    the numbers 0 through 9 for the two-key combination when building the
  119.    Open Technote list.  QWHITE.COM will allow you to specify the same
  120.    two-key sequences in more than one technical note.  Although this allows
  121.    some flexibility, it does provide certain limitations for the Open
  122.    Technote menu.  Here is a description of how QWHITE.COM decides which
  123.    technote to view when you select a two-key combination that appears two
  124.    or more times in the Open Technote list:
  125.  
  126.    a) When the first key is pressed, QWHITE.COM searches its internal list
  127.       for any entries that start with the key.  If none are found, you will
  128.       hear a beep and the key will be ignored.
  129.  
  130.    b) When the second key is press QWHITE.COM starts with the first entry
  131.       on the current Open Technote screen when searching for a matching
  132.       two-key selection.
  133.  
  134.    c) If the two-key combination you type is on the screen, QWHITE.COM will
  135.       open that technote.
  136.  
  137.    d) If the two-key combination is not on the current screen, QWHITE.COM
  138.       will search to the end of the Open Technote list to find an entry
  139.       that matches.  If none is found, it will go back to the top of the
  140.       list and search from there until if finds a valid entry and opens it.
  141.       If none are found, you will here a beep when you press the second
  142.       key.
  143.  
  144.    e) If two or more entries with the same two-key combination appear on
  145.       the same screen, QWHITE.COM will ALWAYS open the first.  You will
  146.       need to select the second (third, fourth, etc) manually by using the
  147.       cursor keys to highlight the entry and pressing enter -or- by
  148.       clicking on it with the left mouse button.
  149.  
  150. Search Technotes:
  151.  
  152.    The Search Technotes option allows scanning all technical notes on the
  153.    Open Technote menu for the character string you specify.  It is not case
  154.    sensitive and it will also ignore trailing spaces when scanning the
  155.    files. There are two options for searching: Start Search and Continue
  156.    Search. Start Search ALWAYS starts with the first entry in your Open
  157.    Technote list.  Continue Search is only active if Start Search
  158.    previously found a match.  If so, it will continue searching from the
  159.    point of the last match. If either Search option reaches the last entry
  160.    in the Open Technote list the Continue Search option will be disabled.
  161.    If either search option finds a match, the file will be loaded into the
  162.    list window.  The page that contains the match will be displayed and the
  163.    line that contains the match will he highlighted.
  164.  
  165. Create new Open menu:   Adding new technical notes to the Open Technote menu
  166.  
  167.    The Create new Open menu searches all files in its directory for files
  168.    that have a specific ID line at the beginning of the file (NOTE: See
  169.    Technical Note Header).  The file should be normal ASCII files without
  170.    special control codes in it. Your editor or word processor may refer to
  171.    it as Non-Document, Text, or ASCII files.  See the notes on Technical
  172.    Note File Types.
  173.  
  174.    Your own technical notes may be added to the Open Technote menu by
  175.    inserting an ID line at the begining of the file.  Your file should be
  176.    copied to the directory where QWHITE.COM is located and the Create
  177.    option should be selected from the menu.
  178.  
  179.    QWHITE.COM can only display 256 optins on the Open Technote menu at a
  180.    time.  If you have more than 256 files you will need to create a second
  181.    subdirectory and divide your technical notes between the two
  182.    subdirectories and place a copy of QWHITE.COM in each.  Run DESqview's
  183.    Change a Program and modify the Directory field to point to the new
  184.    subdirectory and change the 'Keys to Use on Open Menu' create a second
  185.    entry for the new subdirectory.
  186.  
  187. Technical Note Header:        Example: See the first line of this file
  188.  
  189.    QWHITE.COM checks the first line of a file for a specific character
  190.    sequence to identify the file as a technical note for including in the
  191.    Open Technote menu.  The first three characters should be 'ID:' (NOTE:
  192.    the single quotes should not be not included).  The next two characters
  193.    are the two keys used on the Open Technote menu.  This is similar to
  194.    DESQview's own Open Window menu except QWHITE.COM allows duplicates. The
  195.    next character MUST be a space.  Finally, the next 35 characters will be
  196.    used on the Open Technote menu to describe the file,  much as the
  197.    Program Name field of Change A Program is used to identify the entry on
  198.    DESQview's Open Window Menu. Also, it is not necessary to provide all 35
  199.    characters,  QWHITE.COM will automatically stop if it finds a linefeed
  200.    character.
  201.  
  202. Technical Note File Types:
  203.  
  204.    QWHITE.COM will attempt to display ANY file that contains a valid
  205.    header. However, for best results, you should use an editor or word
  206.    processor that can create normal ASCII format files.  Your editor/word
  207.    processor may refer to this type of file as NON-DOCUMENT, ASCII, TEXT,
  208.    or some similar name.
  209.  
  210.    QWHITE.COM processes the following control codes, all others are ignored
  211.    and not displayed.
  212.  
  213.    LINEFEED    - indicates the end of a line.  If you experience trouble
  214.                  viewing your document, make sure your word processor is
  215.                  creating a TEXT file instead of its own DOCUMENT file
  216.                  format.
  217.  
  218.    TAB         - moves the 'cursor' 8 positions before printing the next
  219.                  character.  This is a non-standard method of displaying
  220.                  the TAB character.  It is designed to allow you to
  221.                  compress a file that is 'slightly' larger than 64k by
  222.                  replacing sequences of 8 blanks with a tab character.
  223.  
  224.    END OF FILE - indicates the end of the file.  If no END OF FILE marker
  225.                  is found, the physical file size will be used.
  226.  
  227.    OTHERS      - All other control codes will be ignored and not displayed.
  228.  
  229.    Additionally, QWHITE.COM will display a maximum of 78 characters/line
  230.    and drop any characters found after that position.
  231.  
  232. Reading Technical Notes:
  233.  
  234.    The view mode of QWHITE.COM provides a simple interface for reading a
  235.    technical note.  The following keys are active when reading a technote:
  236.  
  237.  
  238.                 P      Print
  239.  
  240.                 Up     Scroll up
  241.  
  242.                 Down   Scroll down
  243.  
  244.                 PgUp   Previous page
  245.  
  246.                 PgDn   Next page
  247.  
  248.                 Home   Top of the file
  249.  
  250.                 End    End of file
  251.  
  252.                 Esc    Exit window
  253.  
  254.              *  F2     Continue search.
  255.  
  256.    * The F2 key is an invisible option.  This option is available only when
  257.    the the search option displays a file.  It allows you to select Continue
  258.    Search without having to return to the Search menu.
  259.  
  260. File Size limits: 64k
  261.  
  262.    QWHITE.COM will not display files that are larger than 64k.  Since the
  263.    technical documents are written to answer a specific question or solve a
  264.    specific problem, by nature, they should be concise and we have found
  265.    they often fit on a single sheet of paper. The 64k limit we choose is
  266.    merely a convenience from a programming standpoint.  In actuality, 64k
  267.    is generally too large for a technical note and should probably be
  268.    rewritten in a more concise manner or as two or more separate technical
  269.    notes.  See the note on TAB in the section discussing Control Codes
  270.    above if you have a file that exceeds 64k.
  271.  
  272. Printing:
  273.  
  274.    The List window provides the option for printing a technical note.  This
  275.    option is here for those times when you want to quickly print the
  276.    technical note you are viewing.  If you have need for extensive printing
  277.    or printer specific options, you may want to open a seperate DESQview
  278.    and perform your printing from there.  When you select the Print field
  279.    or press the letter P, a window will pop up indicating the name of the
  280.    file that will be printed.  You may press Esc at this time to cancel the
  281.    request or Enter to start printing.  A running total of lines printed
  282.    will be displayed as the file prints.  You may press Enter or Escape
  283.    while the file is being printed to abort the print. QWHITE.COM will send
  284.    a formfeed character at this point, or when it finishes printing the
  285.    file to the printer and return you to the list window.  QWHITE.COM
  286.    prints to the standard printer device. In other words, what ever printer
  287.    is currently assigned to PRN will be used by QWHITE.COM.  This will
  288.    allow your print spooler loaded before DESQview to capture the output
  289.    from the White Papers.
  290.  
  291. Printer Setup:
  292.  
  293.    QWHITE.COM does not attempt to perform any printer setup commands.  If
  294.    you wish to have the printer set up a particular way you have two
  295.    options:
  296.  
  297.    1: Many printers provide setup capabilities from a control panel on the
  298.       printer.  If you use this method, do so before selecting Print from
  299.       the list screen.
  300.  
  301.    2: There are numerous utilities available that allow the user to set up
  302.       the printer from software.  If you have DESQview configured to manage
  303.       printer contention, you may need to run your utility prior to running
  304.       the White Papers.  If you do not have DESQview configured to manage
  305.       printer contention, you can open another window and run the utility
  306.       prior to selecting the Print option from QWHITE.COM's list screen.
  307.  
  308. Using The Quarterdeck White Papers on a Network:
  309.  
  310.    QWHITE.COM does not make network specific calls.  If multiple users will
  311.    be running QWHITE.COM from a network drive, the network administrator
  312.    will need to establish some constraints for file access:
  313.  
  314.    a: Generally, only ONE user should have create rights to the file
  315.       QWHITE.WPO.  All other users should have read-only access.
  316.       QWHITE.COM checks the read-only file attribute on startup and will
  317.       disable the Create New Open Menu option for users with this file
  318.       attribute set.  When a new technical note is added to the directory
  319.       QWHITE.COM is run from, the user with create rights should choose the
  320.       Create New Open Menu option to generate a new QWHITE.WPO file.  Other
  321.       users can then restart the program to see the new Open Technote
  322.       entry.
  323.  
  324.    b: Users that do not have the read-only attribute set for QWHITE.WPO and
  325.       also do NOT have create rights will be able to select the create
  326.       option.  QWHITE will scan the files and create the Open Technote memu
  327.       in memory but will generate an error message when it attempts to
  328.       write the file to disk.
  329.  
  330.    c: QWHITE.COM attempts to open technote files in read-only mode.  If the
  331.       file has been locked by a user then QWHITE.COM will not be able to
  332.       display the file.  Some word processors and file viewing utilities
  333.       disable read access to files being edited. Technical notes are loaded
  334.       completely into memory when selected and closed immediately.  These
  335.       files are not left open.
  336.  
  337.    d: QWHITE.COM loads QWHITE.WPO at startup and then closes the file.  It
  338.       does not leave the file open after it has been loaded.
  339.  
  340.  
  341.                Copyright (C) 1990 by Quarterdeck Office Systems
  342.                     * * *   E N D   O F   F I L E    * * *
  343.